home *** CD-ROM | disk | FTP | other *** search
/ Aminet 52 / Aminet 52 (2002)(GTI - Schatztruhe)[!][Dec 2002].iso / Aminet / dev / asm / ESA.lha / ESA / examples / readme
Text File  |  2002-10-11  |  3KB  |  90 lines
  1. ******************************************************************************
  2. * information about the contents of this directory
  3.  
  4.  
  5.  
  6. ******************************************************************************
  7. * DISCLAIMER
  8.  
  9.  ***********************************************************************
  10.  * THE SOFTWARE IN THIS DIRECTORY IS PROVIDED "AS-IS" WITHOUT WARRANTY *
  11.  * OF ANY KIND EITHER EXPRESSED OR IMPLIED.                            *
  12.  * I (Simone Bevilacqua) ACCEPT NO RESPONSABILITY OR LIABILITY FOR ANY *
  13.  * DAMAGE OR PROBLEM: USE AT YOUR OWN RISK!!!                          *
  14.  ***********************************************************************
  15.  
  16.  
  17.  
  18. ******************************************************************************
  19. * tabulation
  20.  
  21. This sources have been written using the following tabulation:
  22.  
  23. label           instruction  operands                 comment
  24.  
  25. T               T            T                        T
  26.  
  27.  
  28.  
  29. ******************************************************************************
  30. * function/procedures header description
  31.  
  32.  Each subroutine has an header of the kind:
  33.  
  34. ******************************************************************************
  35. * RoutineName a.c.r
  36. ******************************************************************************
  37. * INFO          ...
  38. * SYN           ...
  39. *               ...
  40. * IN            ...
  41. * OUT           ...
  42. * MOD           ...
  43. * REQ           ...
  44. * WARN          ...
  45. * NOTE          ...
  46. ******************************************************************************
  47.  
  48.  - "RoutineName" indicates the name of the procedure/function
  49.  
  50.  - "a.c.r" indicates the version according to this versioning system:
  51.     a=algorithm version (this changes when an algorithm replaces the
  52.                          previous, structurally different, one)
  53.     c=compatibility     (this increases when the modifications made to
  54.                          the source force changes also to the sources
  55.                          which call the func/proc; in practice when the
  56.                          proc/func can't be used [safely] in the same
  57.                          way/place as before the changes)
  58.     r=revision          (increased when bugfixes, optimizations, or any
  59.                          other operation which doesn't affect compatibi-
  60.                          lity or doesn't represent a major change in the
  61.                          algorithm structure are made)
  62.  
  63.  - "INFO" gives a brief description of what the routine does
  64.  
  65.  - "SYN" shows how to make the call.
  66.    For example:
  67.     OutValue = RoutineName[arg0,arg1]
  68.     d0                     a0   d1
  69.     Means that "RoutineName" is a function which requires two parameters
  70.     ("arg0" and "arg1") as input and returns a value, indicated as "Out-
  71.     Value" in d0
  72.  
  73.  - "IN" is a list of the input arguments, describing their meaning and
  74.    the expected/allowed values
  75.  
  76.  - "OUT" gives a description of the value returned by a function
  77.  
  78.  - "MOD" lists all the variables/locations which are modified inside the
  79.    routine and are not restored on exit
  80.  
  81.  - "REQ" here are listed all the variables,definitions, etc. needed by
  82.    the routine to be compiled or work correctly
  83.  
  84.  - "WARN" informs you about some particularly critical aspects of the
  85.    routine
  86.  
  87.  - "NOTE" additional info regarding important aspects of the routine
  88.  
  89.  Any of these fields can be omitted.
  90.